日志工具 Commons Logging
Commons Logging 是什么?
和 Java 标准库提供的日志不同,Commons Logging 是一个第三方日志库,它是由Apache创建的日志模块。
Commons Logging的特色是,它可以挂接不同的日志系统,并通过配置文件指定挂接的日志系统。默认情况下,Commons Loggin 自动搜索并使用 Log4j(Log4j 是另一个流行的日志系统),如果没有找到 Log4j,再使用 JDK Logging。
快速使用
先引入依赖:
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>
使用 Commons Logging 只需要和两个类打交道,并且只有两步:
- 第一步,通过LogFactory获取Log类的实例;
- 第二步,使用Log实例的方法打日志。
示例代码如下:
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
public class Main {
public static void main(String[] args) {
Log log = LogFactory.getLog(Main.class);
log.info("start...");
log.warn("end.");
}
}
使用方式
Commons Logging 定义了 6个日志级别:
- FATAL
- ERROR
- WARNING
- INFO
- DEBUG
- TRACE
默认级别是 INFO。
使用 Commons Logging 时,如果在静态方法中引用 Log,通常直接定义一个静态类型变量:
// 在静态方法中引用Log:
public class Main {
static final Log log = LogFactory.getLog(Main.class);
static void foo() {
log.info("foo");
}
}
在实例方法中引用 Log,通常定义一个实例变量:
// 在实例方法中引用Log:
public class Person {
protected final Log log = LogFactory.getLog(getClass());
void foo() {
log.info("foo");
}
}
注意到实例变量 log 的获取方式是 LogFactory.getLog(getClass())
,虽然也可以用 LogFactory.getLog(Person.class)
,但是前一种方式有个非常大的好处,就是子类可以直接使用该 log 实例。例如:
// 在子类中使用父类实例化的log:
public class Student extends Person {
void bar() {
log.info("bar");
}
}
由于 Java 类的动态特性,子类获取的 log 字段实际上相当于 LogFactory.getLog(Student.class)
,但却是从父类继承而来,并且无需改动代码。
此外,Commons Logging的日志方法,例如 info()
,除了标准的 info(String)
外,还提供了一个非常有用的重载方法:info(String, Throwable)
,这使得记录异常更加简单:
try {
...
} catch (Exception e) {
log.error("got exception!", e);
}